<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Percepio Trace Recorder: Trace Runnable APIs</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Percepio Trace Recorder<span id="projectnumber">&#160;v4.9.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('group__trace__runnable__apis.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">Trace Runnable APIs<div class="ingroups"><a class="el" href="group__trace__recorder__apis.html">Trace Recorder APIs</a></div></div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gac70437d35d979dc2d86a5e84f2468026"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__runnable__apis.html#gac70437d35d979dc2d86a5e84f2468026">xTraceRunnableStart</a>(xRunnableHandle)&#160;&#160;&#160;<a class="el" href="group__trace__event__apis.html#ga676dd9f79556a3343072b14fac51af1d">xTraceEventCreate1</a>(PSF_EVENT_RUNNABLE_START, (TraceUnsignedBaseType_t)(xRunnableHandle))</td></tr>
<tr class="memdesc:gac70437d35d979dc2d86a5e84f2468026"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an event indicating a runnable started.  <br /></td></tr>
<tr class="separator:gac70437d35d979dc2d86a5e84f2468026"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga966ad065b5646cf85599f845e4a25f0d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__runnable__apis.html#ga966ad065b5646cf85599f845e4a25f0d">xTraceRunnableStop</a>()&#160;&#160;&#160;<a class="el" href="group__trace__event__apis.html#ga63f12da033faf0f4de4ef2755d73b308">xTraceEventCreate0</a>(PSF_EVENT_RUNNABLE_STOP)</td></tr>
<tr class="memdesc:ga966ad065b5646cf85599f845e4a25f0d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an event indicating a runnable stopped.  <br /></td></tr>
<tr class="separator:ga966ad065b5646cf85599f845e4a25f0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab0c0cd7ac030b7d6b1681569f6e668d4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__runnable__apis.html#gab0c0cd7ac030b7d6b1681569f6e668d4">xTraceRunnableRegisterStaticSet</a>(szName,  uiMajor,  uiMinor,  uiPatch,  uiRunnableCount,  pxRunnableSetHandle)&#160;&#160;&#160;<a class="el" href="group__trace__extension__apis.html#ga358cdec30d87e1659cbb5dc551c5c310">xTraceExtensionCreate</a>(szName, uiMajor, uiMinor, uiPatch, uiRunnableCount, pxRunnableSetHandle)</td></tr>
<tr class="memdesc:gab0c0cd7ac030b7d6b1681569f6e668d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers a set of static runnables. Requires XML configuration to properly interpret.  <br /></td></tr>
<tr class="separator:gab0c0cd7ac030b7d6b1681569f6e668d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae7d1e5c2b428e862c9442caadf1f7bc3"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__runnable__apis.html#gae7d1e5c2b428e862c9442caadf1f7bc3">xTraceRunnableStartStatic</a>(xRunnableSetHandle,  uiRunnableId)&#160;&#160;&#160;<a class="el" href="group__trace__event__apis.html#ga63f12da033faf0f4de4ef2755d73b308">xTraceEventCreate0</a>(<a class="el" href="group__trace__extension__apis.html#ga0e4ca1424c866797c717daaa117937a1">xTraceExtensionGetEventId</a>(xRunnableSetHandle, uiRunnableId))</td></tr>
<tr class="memdesc:gae7d1e5c2b428e862c9442caadf1f7bc3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start a static runnable. Requires XML configuration to properly interpret.  <br /></td></tr>
<tr class="separator:gae7d1e5c2b428e862c9442caadf1f7bc3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad0aaf19fdfa320baa167f91e77002dec"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__runnable__apis.html#gad0aaf19fdfa320baa167f91e77002dec">xTraceRunnableStopStatic</a>()&#160;&#160;&#160;<a class="el" href="group__trace__runnable__apis.html#ga966ad065b5646cf85599f845e4a25f0d">xTraceRunnableStop</a>()</td></tr>
<tr class="memdesc:gad0aaf19fdfa320baa167f91e77002dec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop a static runnable. Requires XML configuration to properly interpret.  <br /></td></tr>
<tr class="separator:gad0aaf19fdfa320baa167f91e77002dec"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga21ef51f2da2860964e5754065d6c7756"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__runnable__apis.html#ga21ef51f2da2860964e5754065d6c7756">xTraceRunnableRegister</a> (const char *szName, TraceRunnableRegisterMethod_t uxRegisterMethod, TraceRunnableHandle_t *pxRunnableHandle)</td></tr>
<tr class="memdesc:ga21ef51f2da2860964e5754065d6c7756"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers a runnable. Can be called multiple times, will not create additional entries.  <br /></td></tr>
<tr class="separator:ga21ef51f2da2860964e5754065d6c7756"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="gab0c0cd7ac030b7d6b1681569f6e668d4" name="gab0c0cd7ac030b7d6b1681569f6e668d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab0c0cd7ac030b7d6b1681569f6e668d4">&#9670;&#160;</a></span>xTraceRunnableRegisterStaticSet</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define xTraceRunnableRegisterStaticSet</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">szName, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">uiMajor, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">uiMinor, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">uiPatch, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">uiRunnableCount, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">pxRunnableSetHandle&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;<a class="el" href="group__trace__extension__apis.html#ga358cdec30d87e1659cbb5dc551c5c310">xTraceExtensionCreate</a>(szName, uiMajor, uiMinor, uiPatch, uiRunnableCount, pxRunnableSetHandle)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Registers a set of static runnables. Requires XML configuration to properly interpret. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">szName</td><td>Name. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uiMajor</td><td>Major version. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uiMinor</td><td>Minor version. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uiPatch</td><td>Patch version. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uiRunnableCount</td><td>Runnables count. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">pxRunnableSetHandle</td><td>Pointer to uninitialized TraceRunnableStaticSetHandle_t.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gac70437d35d979dc2d86a5e84f2468026" name="gac70437d35d979dc2d86a5e84f2468026"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac70437d35d979dc2d86a5e84f2468026">&#9670;&#160;</a></span>xTraceRunnableStart</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define xTraceRunnableStart</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">xRunnableHandle</td><td>)</td>
          <td>&#160;&#160;&#160;<a class="el" href="group__trace__event__apis.html#ga676dd9f79556a3343072b14fac51af1d">xTraceEventCreate1</a>(PSF_EVENT_RUNNABLE_START, (TraceUnsignedBaseType_t)(xRunnableHandle))</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Creates an event indicating a runnable started. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xRunnableHandle</td><td>Runnable handle.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gae7d1e5c2b428e862c9442caadf1f7bc3" name="gae7d1e5c2b428e862c9442caadf1f7bc3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae7d1e5c2b428e862c9442caadf1f7bc3">&#9670;&#160;</a></span>xTraceRunnableStartStatic</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define xTraceRunnableStartStatic</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">xRunnableSetHandle, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">uiRunnableId&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;<a class="el" href="group__trace__event__apis.html#ga63f12da033faf0f4de4ef2755d73b308">xTraceEventCreate0</a>(<a class="el" href="group__trace__extension__apis.html#ga0e4ca1424c866797c717daaa117937a1">xTraceExtensionGetEventId</a>(xRunnableSetHandle, uiRunnableId))</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Start a static runnable. Requires XML configuration to properly interpret. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xRunnableSetHandle</td><td>Handle to initialized runnable set. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uiRunnableId</td><td>Index in the runnable set.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga966ad065b5646cf85599f845e4a25f0d" name="ga966ad065b5646cf85599f845e4a25f0d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga966ad065b5646cf85599f845e4a25f0d">&#9670;&#160;</a></span>xTraceRunnableStop</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define xTraceRunnableStop</td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td>&#160;&#160;&#160;<a class="el" href="group__trace__event__apis.html#ga63f12da033faf0f4de4ef2755d73b308">xTraceEventCreate0</a>(PSF_EVENT_RUNNABLE_STOP)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Creates an event indicating a runnable stopped. </p>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gad0aaf19fdfa320baa167f91e77002dec" name="gad0aaf19fdfa320baa167f91e77002dec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad0aaf19fdfa320baa167f91e77002dec">&#9670;&#160;</a></span>xTraceRunnableStopStatic</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define xTraceRunnableStopStatic</td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td>&#160;&#160;&#160;<a class="el" href="group__trace__runnable__apis.html#ga966ad065b5646cf85599f845e4a25f0d">xTraceRunnableStop</a>()</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Stop a static runnable. Requires XML configuration to properly interpret. </p>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga21ef51f2da2860964e5754065d6c7756" name="ga21ef51f2da2860964e5754065d6c7756"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga21ef51f2da2860964e5754065d6c7756">&#9670;&#160;</a></span>xTraceRunnableRegister()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceRunnableRegister </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>szName</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceRunnableRegisterMethod_t&#160;</td>
          <td class="paramname"><em>uxRegisterMethod</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceRunnableHandle_t *&#160;</td>
          <td class="paramname"><em>pxRunnableHandle</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Registers a runnable. Can be called multiple times, will not create additional entries. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">szName</td><td>Name. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uxRegisterMethod</td><td>Indicates how to register the runnable. Since there can be thousands of runnables, storing in entry table is not always a good idea. TRC_RUNNABLE_REGISTER_METHOD_USE_ENTRY_TABLE: Store in entry table normally and handle will point to entry. TRC_RUNNABLE_REGISTER_METHOD_USE_STRING_ADDRESS: For this method the string address must be unique and will be used as handle value. TRC_RUNNABLE_REGISTER_METHOD_USE_HANDLE_ADDRESS: For this method the handle address must be unique and will be used as handle value. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">pxRunnableHandle</td><td>Pointer to zero-initialized TraceRunnableHandle_t. If handle that is pointed to is not 0 no entry will be created.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6 </li>
  </ul>
</div>
</body>
</html>
